Skip to content

Adding documentation for System.Net.WebSockets APIs released in 3.0 #2830

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 3 commits into from
Jul 26, 2019
Merged

Adding documentation for System.Net.WebSockets APIs released in 3.0 #2830

merged 3 commits into from
Jul 26, 2019

Conversation

jozkee
Copy link
Member

@jozkee jozkee commented Jul 25, 2019

APIs documented:

  • ClientWebSocket
    • ReceiveAsync(System.Memory{System.Byte}, ...)
    • SendAsync(System.ReadOnlyMemory{System.Byte}, ...)

I extracted the documentation from the previously existing overloads, just changed the summary a bit to try to disambiguate.
Added missing exceptions on existing APIs of SendAsync and ReceiveAsync as well.

@jozkee jozkee requested a review from karelz as a code owner July 25, 2019 20:26
@jozkee
Copy link
Member Author

jozkee commented Jul 25, 2019

@dotnet/ncl
@rpetrusha @mairaw @carlossanlop

@mairaw mairaw added 🏁 Release: .NET Core 3.0 :checkered_flag: Release: .NET Core 3.0 new-content Indicates PRs that contain new articles labels Jul 25, 2019
@mairaw mairaw added this to the July 2019 milestone Jul 25, 2019
carlossanlop
carlossanlop reviewed Jul 26, 2019
View reviewed changes
carlossanlop
carlossanlop approved these changes Jul 26, 2019
View reviewed changes
Copy link
Contributor

@carlossanlop carlossanlop left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, if @scalablecory, @mairaw and @rpetrusha agree with everything else.

mairaw
mairaw approved these changes Jul 26, 2019
View reviewed changes
Copy link
Contributor

@mairaw mairaw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good @jozkee. Made some minor changes. Please take a look and see if you approve them.

@mairaw mairaw added verify-build-before-merge waiting-on-feedback Indicates PRs that are waiting for feedback from SMEs before they can be merged labels Jul 26, 2019
@jozkee
Copy link
Member Author

jozkee commented Jul 26, 2019

Fixed double-spacing in other two summaries.
@mairaw LGMT.

@mairaw mairaw removed the waiting-on-feedback Indicates PRs that are waiting for feedback from SMEs before they can be merged label Jul 26, 2019
@mairaw
Copy link
Contributor

mairaw commented Jul 26, 2019

Good catch! I'll merge as soon as the build finishes.

@mairaw mairaw merged commit e0ff280 into dotnet:master Jul 26, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mairaw mairaw mairaw approved these changes

@karelz karelz Awaiting requested review from karelz

@rpetrusha rpetrusha Awaiting requested review from rpetrusha

@scalablecory scalablecory Awaiting requested review from scalablecory

@wfurt wfurt Awaiting requested review from wfurt

@davidsh davidsh Awaiting requested review from davidsh

+1 more reviewer

@carlossanlop carlossanlop carlossanlop approved these changes

Reviewers whose approvals may not affect merge requirements
Assignees

@jozkee jozkee

Labels
🏁 Release: .NET Core 3.0 :checkered_flag: Release: .NET Core 3.0 new-content Indicates PRs that contain new articles
Projects
None yet
Milestone
July 2019
Development

Successfully merging this pull request may close these issues.
3 participants
@jozkee @mairaw @carlossanlop